#ifndef OMG_DDS_SUSPENDED_PUBLICATION_HPP_
#define OMG_DDS_SUSPENDED_PUBLICATION_HPP_

/* Copyright (c) 2009-2010, Real-Time Innovations, Inc.
 * Copyright (c) 2010, Object Management Group, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - Neither the names of the above copyright holders nor the names of their
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL A COPYRIGHT HOLDER OR CONTRIBUTOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


template <typename DELEGATE>
class tdds::pub::SuspendedPublication
{
public:
    /**
     * This operation indicates to the Service that the application is about 
     * to make multiple modifications using DataWriter objects belonging to 
     * the Publisher.
     * It is a hint to the Service so it can optimize its performance by 
     * e.g., holding the dissemination of the modifications and then batching 
     * them. It is not required that the Service use this hint in any way.
     * The use of this operation must be matched by a corresponding call to
     * resume_publications indicating that the set of modifications has 
     * completed. If the Publisher is deleted before resume_publications
     * is called, any suspended updates yet to be published will be discarded.
     *
     * @return true if pubblications were suspended. False if the method
     *         was called on an already suspended publisher.
     */
    explicit SuspendedPublication(dds::pub::Publisher& pub);
    SuspendedPublication(const SuspendedPublication& src);

public:
    ~SuspendedPublication();    // resumes publications implicitly

public:
    /**
     * This operation indicates to the Service that the application has 
     * completed the multiple changes initiated by the previous 
     * suspend_publications. This is a hint to the Service that can be used 
     * by a Service implementation to e.g., batch all the modifications made 
     * since the suspend_publications.
     * The call to resume_publications must match a previous call to 
     * suspend_publications. Otherwise the operation will return the 
     * error PRECONDITION_NOT_MET.
     */
    void resume();              // resumes publications explicitly

    // --- State: --- //
private:
    friend class OMG_DDS_SUSPENDED_PUBLICATION_DELEGATE;
    DELEGATE impl_;
};


#endif // !defined(OMG_DDS_SUSPENDED_PUBLICATION_HPP_)
